PATCH /users/{userId}

Parameters

Path Parameters

userId string

requiredpath

Request Body

requiredapplication/json

Schema: UserUpdate

200 Updated user

Content-Type: application/json

Schema: User

400 Validation failed

Content-Type: application/json

404 Resource not found

Examples

BASH

curl -X PATCH "https://api.example.com/users/id_123" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "display_name": "string",
  "roles": [
    "admin"
  ],
  "preferences": {}
}'

python

PYTHON

import requests

url = "https://api.example.com/users/id_123"
headers = {
    "Authorization": "Bearer " + API_KEY,
    "Content-Type": "application/json",
}

payload = {
    "display_name": "string",
    "roles": [
        "admin"
    ],
    "preferences": {}
}

response = requests.patch(url, headers=headers, json=payload)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/users/id_123";

const options = {
  method: "PATCH",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "display_name": "string",
    "roles": [
        "admin"
    ],
    "preferences": {}
}),
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/users/id_123"

	body := []byte(`{"display_name": "string", "roles": ["admin"], "preferences": {}}`)
	req, err := http.NewRequest("PATCH", url, bytes.NewBuffer(body))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/users/id_123")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"
request["Content-Type"] = "application/json"

request.body = '{\n  "display_name": "string",\n  "roles": [\n    "admin"\n  ],\n  "preferences": {}\n}'

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/users/id_123";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
        'Content-Type' => 'application/json',
    ],
    'json' => ['display_name' => 'string', 'roles' => ['admin'], 'preferences' => []],
];

$response = $client->request('PATCH', $url, $options);

echo $response->getBody();

Update user profile

Parameters

Path Parameters

Request Body

Responses

Parameters

Link Path Parameters

Path Parameters